SureTax Returns API

DELETE Tax Items

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint enables the deletion of tax items, providing the capability to remove specific tax items. Deletion operations are filtered based on externalReportingEntity and companyCode parameters, allowing targeted removal of tax items associated with specific entities and companies. It's worth noting that while this endpoint offers valuable functionality, its usage is optional and may not be mandatory for all scenarios.

OperationId: DELETE Tax Items

Authorization Method(s): OAuth

Verb: DELETE

End Point: /api/v1/Forms/TaxItems

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
External Reporting Entity	externalReportingEntity	string
Data	data	DeleteTaxItemRequest

DeleteTaxItemRequest

Display Name	Field Name	Field Type
Company Code	companyCode	string
Reporting Date From	reportingDateFrom	string
Reporting Date To	reportingDateTo	string

Example Request

The following is an json request for this operation.

{
  "externalReportingEntity": "string",
  "data": {
    "companyCode": "string",
    "reportingDateFrom": "string",
    "reportingDateTo": "string"
  }
}

Request Headers

Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.

Display String	Field Name	Field Type
X-request-id*	x-request-id	string

*Mandatory parameter

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
202	The API responds with this code to indicate that the data was sent successfully.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/TaxItems

Add Request Headers:

{
  "externalReportingEntity": "string",
  "data": {
    "companyCode": "string",
    "reportingDateFrom": "string",
    "reportingDateTo": "string"
  }
}